Salesforce UX API

(0 reviews)

TMF654- topupBalance towards Matrixx

Create Topup towards Matrixx (Rating system)

URL

https://[localhost]:[port]/sfdc-ux/v1/{businessId}/topupBalance

Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y

name	value	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
lob	string	The Line of Business Identifier currently available are: FIXED PREPAID POSTPAID	Y
channeId	string	Channel to business: Can be one of: "SFDC-B2C”, “SFDC-B2B"	Y
targetSystem	String	This describes the end system request is for Eg: “Aria”, “Matrixx”.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Request

{
    "id": "ABC1111",
    "amount": {
        "amount": 1,
        "units": "USD"
    },
    "voucher": "fake-valid-nonce",
    "product": [
        {
            "id": "",
            "name": "RechargeOffer",
            "@type": "Offer"
        }
    ],
    "relatedParty": [
        {
            "id": "628935575",
            "@type": "PaymentGatewayUserId"
        },
        {
            "id": "0",
            "@type": "PaymentGatewayId"
        },
        {
            "id": "374373",
            "@type": "OrderItemId"
        }
    ],
    "partyAccount": {
        "id": "00116335_0000637717",
        "@type": "SubscriptionRef"
    },
    "channel": {
        "name": "sfdc-b2c",
        "id": ""
    }
}

Definitions

Each of the request parameters is detailed.

name	type	description	required
id	string	The unique order id used in the authorise or settlement request. This can be used to track the transaction and aids duplicate checking.	N
amount	Quantity	An amount in a given unit	Y
amount.amount	string	Top-Up Amount	Y
amount.units	string	Unit	N
product	array	A reference to the Product associated with this bucket.	N
product.id	string	unique identifier	N
product.name	string	Name of the related entity.	N
product.@type	string	When sub-classing, this defines the sub-class Extensible name	N
partyAccount	object	PartyAccount reference. A party account is an arrangement that a party has with an enterprise that	Y
partyAccount.id	string	Either subscriber by ExternalID or associated device access number	Y
partyAccount.@type	string	When sub-classing, this defines the sub-class entity name	N
voucher		Nonce to use for authorization. Note - Either "PaymentMethodResourceId" or "voucher" only allow. Both should not allow	Y*
relatedParty	array	Used to provide information about any other entity with relation to the operation	Y
relatedParty.id		Unique identifier of a related entity.	Y

relatedParty values

name	type	description	required
PaymentGatewayUserId	string	Identifier for the customer id on the payment gateway.	Y
PaymentGatewayId	string	Identifier for the specific payment gateway. If not supplied, the default payment gateway will be used.",	Y
OrderItemId	string	Order Item Id	Y

Response

{
    "id": "ABC1111",
    "confirmationDate": "2024-05-13T06:48:43.000Z",
    "status": "Approved",
    "amount": {
        "amount": 1,
        "units": "USD"
    },
    "voucher": "fake-valid-nonce",
    "product": [
        {
            "id": "0",
            "name": "RechargeOffer",
            "@type": "Offer"
        }
    ],
    "validFor": {
        "endDateTime": "65535-12-31T23:59:59.999999Z",
        "startDateTime": "2023-10-05T11:37:49.000Z"
    },
    "relatedParty": [
        {
            "id": "628935575",
            "@type": "PaymentGatewayUserId"
        },
        {
            "id": "0",
            "@type": "PaymentGatewayId"
        },
        {
            "id": "374373",
            "@type": "OrderItemId"
        },
        {
            "id": "121",
            "@type": "PaymentResourceIdRef"
        }
    ],
    "bucket": {
        "id": "1",
        "name": "Prepaid Balance"
    },
    "impactedBucket": [
        {
            "amountAfter": 1.12,
            "name": "Total Amount",
            "item": [
                {
                    "amount": 0.11,
                    "name": "STATE SALES TAX"
                },
                {
                    "amount": 0.01,
                    "name": "CITY SALES TAX"
                }
            ]
        }
    ],
    "partyAccount": {
        "id": "00116335_0000637717",
        "@type": "SubscriptionRef"
    }
}

Definitions

Each of the request parameters is detailed.

name	type	description	required
confirmationDate	datetime	Date when the deduction was confirmed in the server	N
status	string	Valid values for the Action Status Type	N
validFor	object	A period of time, either as a deadline (endDateTime only) a startDateTime only, or both	N
validFor.startDateTime	datetime	Start time of the balance. For a periodic or on-demand balance, it is the start time of the period. For a simple balance, it is the start validity time of the balance.",	N
validFor.endDateTime	datetime	End time of the balance. For a periodic or on-demand balance, it is the end time of the period. For a simple balance, it is the end validity time of the balance.",	N
bucket	object	link to the resource that holds bucket information	N
bucket.id	string	Resource ID of balance instance.	N
bucket.name	string	Name of balance template as defined in My MATRIXX.	N
impactedBucket	array	A list of impacted buckets	N
impactedBucket.amountAfter	Quantity	Amount of balance update.	N
impactedBucket.name	string	Total Amount	N
impactedBucket.item	array	A list of impacted bucket items	N
impactedBucket.item.amount	Quantity	Amount of balance update.	N
impactedBucket.item.name	string	Tax name	N
		and concatenated the complete request body	N

Salesforce UX API

TMF654- topupBalance towards Matrixx

URL

Param

Header

Request

Definitions

relatedParty values

Response

Definitions

Reviews